Skip to main content
POST
/
v1
/
customers
/
{id}
/
credits
Create credit product
curl --request POST \
  --url https://api.hyperline.co/v1/customers/{id}/credits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_id": "itm_3kXODDF42QXtnL",
  "name": "Credit name",
  "current_balance": 2000,
  "low_count_threshold": 10,
  "auto_topup": {
    "credit_count": 32,
    "amount_excluding_tax": 2000,
    "price_id": "<string>"
  }
}
'
{
  "product_id": "itm_3kXODDF42QXtnL",
  "customer_id": "cus_Typ0px2W0aiEtl",
  "name": "Credit name",
  "current_balance": 2000,
  "low_count_threshold": 10,
  "last_refreshed_at": "2025-11-23T09:00:01.860Z",
  "auto_topup": {
    "credit_count": 32,
    "amount_excluding_tax": null,
    "price_id": null
  },
  "created_at": "2025-10-12T07:00:01.860Z",
  "updated_at": "2025-10-13T10:00:01.860Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json

Create credit payload

​
product_id
string
required

Credit product ID.

Example:

"itm_3kXODDF42QXtnL"

​
name
string

Credit name.

Example:

"Credit name"

​
current_balance
number

Current credit balance.

Example:

2000

​
low_count_threshold
number | null

Value indicating a low threshold.

Example:

10

​
auto_topup
object

Auto top-up options.

Response

201 - application/json

Credit created

​
product_id
string
required

Credit product ID.

Example:

"itm_3kXODDF42QXtnL"

​
customer_id
string
required

Customer ID related to the credit.

Example:

"cus_Typ0px2W0aiEtl"

​
name
string
required

Credit name.

Example:

"Credit name"

​
current_balance
number
required

Current credit balance.

Example:

2000

​
low_count_threshold
number | null
required

Value indicating a low threshold.

Example:

10

​
last_refreshed_at
string<date-time>
required

Credit last refresh date. UTC date time string in the ISO 8601 format.

Example:

"2025-11-23T09:00:01.860Z"

​
auto_topup
object
required

Auto top-up options.

​
created_at
string<date-time>
required

Credit creation date. UTC date time string in the ISO 8601 format.

Example:

"2025-10-12T07:00:01.860Z"

​
updated_at
string<date-time>
required

Credit last edition date. UTC date time string in the ISO 8601 format.

Example:

"2025-10-13T10:00:01.860Z"